home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr31 / qzip104.zip / QUNZIP.DOC next >
Text File  |  1993-06-04  |  19KB  |  412 lines
  1.  
  2.                           Qunzip Version 1.04
  3.     Copyright (c) 1991 - 1993 by Michael Leavitt, All Rights Reserved
  4.  
  5. Quick Command Reference:
  6. ─────────────────────────────────────────────────────────────────────────────
  7.         Usage: QUNZIP [-options] zipfile [destination] [filespecs...]
  8.  
  9. [-options]:
  10.         -e  extract files (default)
  11.         -b  use BIOS video
  12.         -d  create directories stored in zipfile
  13.         -f  freshen existing files, create none
  14.         -l  list files in short format
  15.         -n  never overwrite existing files
  16.         -o  overwrite files without prompting
  17.         -s  suppress zipfile comment display
  18.         -t  test zipfile integrity
  19.         -u  update files, create if necessary
  20.         -v  list files in verbose format
  21.         -x  extract files (default)
  22.         -z  display zip comment only
  23.         -3  disable use of 32-bit instructions
  24.  
  25.  
  26.         The option letters must be preceded by a minus sign; multiple
  27.         options can follow one minus sign, or each option can have a
  28.         minus sign in front of it.  Options are case sensitive (except
  29.         the -o option).  A detailed description of the options can be
  30.         found later in this document.
  31.  
  32. zipfile:
  33.         The name or pathname of the zipfile(s) to process.  The .ZIP
  34.         extension will automatically be added to this name if you do
  35.         not specify an extension.  Self-extracting ZIP files are also
  36.         supported; be sure to include the .EXE extension for these.
  37.         DOS 'wildcards' can be used to specify more than one zipfile
  38.         to process.
  39.  
  40. [destination]:
  41.         Optional drive letter or subdirectory path where Qunzip will place
  42.         the files it extracts from the zipfile.  If no destination directory
  43.         is specified, Qunzip will place the extracted files in the current
  44.         directory by default.
  45.  
  46. [filespecs...]:
  47.         Optional list of files to extract from zipfile.  You may use DOS
  48.         'wildcards' to specify a group of files, or list the individual
  49.         filenames to extract.  If no filenames are given here, Qunzip will
  50.         extract the entire contents of the zipfile by default.
  51.  
  52.  
  53. Program License Information:
  54. ─────────────────────────────────────────────────────────────────────────────
  55.         Qunzip Version 1.04 is copyrighted commercial software.  You are
  56.         granted a limited license to use this program in conjunction with
  57.         Sparkware's 1st Reader, and in compliance with the usage restrictions
  58.         of 1st Reader.  You may not copy this program or its documentation for
  59.         any purpose other than backup purposes.  Distribution of this program
  60.         or its documentation to persons other than registered users of 1st
  61.         Reader is expressly prohibited.
  62.  
  63.         Michael Leavitt, the author of the Qunzip code, and Sparkware hereby
  64.         disclaim all warranties relating to this software, whether expressed
  65.         or implied, including without limitation any implied warranties of
  66.         merchantability or fitness for a particular purpose.  Neither the
  67.         author nor Sparkware will be liable for any special, incidental,
  68.         consequential, indirect or similar damages due to loss of data or any
  69.         other reason, even if the author, Sparkware, or an agent of the author
  70.         or Sparkware has been advised of the possibility of such damages.
  71.  
  72.         In no event shall the author's or Sparkware's liability for any damages
  73.         ever exceed the price paid for the license to use the software,
  74.         regardless of the form of the claim.  The person using the software
  75.         bears all risk as to the quality and performance of the software.
  76.  
  77.  
  78. Program Description:
  79. ─────────────────────────────────────────────────────────────────────────────
  80.         Qunzip will list, test, or extract files from a ZIP file.  Zipfiles
  81.         created by any version of PKZIP (or compatible) thru version 2.04
  82.         are fully supported with two exceptions: encrypted files are not
  83.         supported, and AV codes are not recognized.
  84.  
  85.         Qunzip automatically detects the type of CPU that it is running on,
  86.         and takes advantage of the capabilities of each to the fullest.
  87.  
  88.         Qunzip provides a colorful pop-up display that includes an animated
  89.         extraction status display.  This allows Qunzip to be run as a shell
  90.         process from another program and appear to be an integrated part
  91.         of that program.
  92.  
  93.         Qunzip gives fast performance rivaling PKUNZIP, but uses much, much
  94.         less memory when operating.  Qunzip does not need or use EMS or XMS
  95.         memory, and only needs 105K of free DOS memory to run.  Qunzip is a
  96.         '32-bit clean' application, and will run under Windows or OS/2 in
  97.         protected mode just as well as it runs under DOS.
  98.  
  99.         Qunzip can successfully process damaged or non-standard ZIP files
  100.         automatically.  In many cases, all files can be extracted from a
  101.         corrupted zipfile with a minimum loss of data.
  102.  
  103.  
  104. Environment Variable Options:
  105. ─────────────────────────────────────────────────────────────────────────────
  106.         Qunzip's default behavior may be modified via options placed into
  107.         the QUNZIP environment variable.  This can be done with any option,
  108.         but it is probably most useful with the -b, -o or -n options in
  109.         order to make Qunzip use video BIOS by default, or to make it always
  110.         overwrite or never overwrite files as it extracts them.
  111.  
  112.         For example, if your display type requires that you use the -b option
  113.         when you use Qunzip, you can add this line:
  114.  
  115.         SET QUNZIP=-b
  116.  
  117.         To your AUTOEXEC.BAT file and Qunzip will then use the video BIOS
  118.         by default.  Environment options are an extension of the command
  119.         line options; any Qunzip options contained in the QUNZIP environment
  120.         variable are considered as being the first options on the command
  121.         line.
  122.  
  123.         You can override environment options by including the same option
  124.         with a trailing minus sign on the command line; the trailing minus
  125.         sign tells Qunzip to turn off that option.  For example, if you have
  126.         set the QUNZIP environment variable to -n so that Qunzip will never
  127.         overwrite files by default and wish to override that setting when
  128.         you unzip a file, just include -n- on the command line and the -n
  129.         option will be turned off.
  130.  
  131.  
  132. Examples:
  133. ─────────────────────────────────────────────────────────────────────────────
  134.         To use Qunzip to extract the contents of MYFILE.ZIP to the current
  135.         directory:
  136.  
  137.                 QUNZIP myfile
  138.  
  139.         To extract the contents of MYFILE.ZIP to the \TEMP subdirectory:
  140.  
  141.                 QUNZIP myfile \temp
  142.  
  143.         To extract all .EXE files from MYFILE.ZIP to the current directory:
  144.  
  145.                 QUNZIP myfile *.exe
  146.  
  147.         To extract all .EXE files from MYFILE.ZIP to the \TEMP subdirectory:
  148.  
  149.                 QUNZIP myfile \temp *.exe
  150.  
  151.         To extract the contents of MYFILE.ZIP to the directories stored in
  152.         the zipfile, creating directories as needed:
  153.  
  154.                 QUNZIP -d myfile
  155.  
  156.         To test MYFILE.ZIP:
  157.  
  158.                 QUNZIP -t myfile
  159.  
  160.         To view the contents of MYFILE.ZIP:
  161.  
  162.                 QUNZIP -v myfile
  163.  
  164.         To extract only newer versions of the files already in the current
  165.         directory from MYFILE.ZIP without prompting:
  166.  
  167.                 QUNZIP -fo myfile
  168.  
  169.         To extract newer versions of the files already in the current
  170.         directory plus any files not already there:
  171.  
  172.                 QUNZIP -uo myfile
  173.  
  174.  
  175. Overwriting Existing Files:
  176. ─────────────────────────────────────────────────────────────────────────────
  177.         If neither the -o or -n options are specified to control whether
  178.         Qunzip will overwrite an existing file with one that is in the
  179.         zipfile, Qunzip will stop and ask you if you'd like to overwrite
  180.         that file.  There are five responses available at that prompt:
  181.  
  182.         y - Yes, overwrite this file.
  183.         n - No, don't overwrite this file.
  184.         N - No, don't overwrite this or any other file; stop asking.
  185.         A - Yes, overwrite this file and any others as needed; don't ask again.
  186.         r - Rename the file being extracted and leave original file in place.
  187.  
  188.         Note that the N and A selections must be typed while the shift key
  189.         is being held down - these selections can be dangerous, and should be
  190.         used with care.
  191.  
  192.  
  193. Detailed Description of Qunzip Options:
  194. ─────────────────────────────────────────────────────────────────────────────
  195. -b  use video BIOS
  196.         Qunzip produces its display using direct video memory access to
  197.         provide the greatest possible speed.  This method of updating the
  198.         screen is compatible with all 'IBM standard' display adapters and
  199.         you should have no need to use the -b option.  However, if your
  200.         display adapter is 'non-standard' and the Qunzip display appears
  201.         scrambled or doesn't appear at all, adding the -b option to the
  202.         command line or the QUNZIP environment variable will cause Qunzip
  203.         to use the video BIOS routines built into your machine to update
  204.         the display.  This option is also useful to eliminate screen 'snow'
  205.         that may appear on old CGA displays when the screen is being updated.
  206.  
  207. -d  recreate directories stored in zipfile
  208.         Some zipfiles may contain the directory structure of the program or
  209.         files contained within.  By default, Qunzip will extract the files
  210.         to the destination directory specified on the command line, or to
  211.         the current directory if no destination directory is specified.  By
  212.         using the -d option when unzipping a file containing directory
  213.         information, Qunzip will extract the files to the current directory,
  214.         creating the stored subdirectories under the currend directory.  If
  215.         you include a destination drive or directory on the command line,
  216.         Qunzip will create the directory structure stored in the zipfile at
  217.         that location instead.
  218.  
  219. -e  extract files
  220.         This is Qunzip's default mode of operation.  Unless a -l, -t, or -v
  221.         option is included on the command line (list or test files), Qunzip
  222.         will extract the files from the zipfile.  This option never needs
  223.         to be used, but is provided for compatibility with other zipfile
  224.         extraction programs.
  225.  
  226. -f  freshen existing files
  227.         This option can be used when you wish to update existing files with
  228.         ones found in a zipfile.  In 'freshen' mode, Qunzip will only
  229.         extract files from the zipfile that have the same name and are newer
  230.         than those already existing; all others are ignored.  'Freshen' only
  231.         updates existing files - it never creates new ones.
  232.  
  233. -l  list contents of zipfile
  234.         Using the -l option on the command line causes Qunzip to produce a
  235.         short listing of the contents of the zipfile.  This listing only
  236.         shows the names, dates, and sizes of the files contained in the
  237.         zipfile.  For more detailed information on the zipfile contents,
  238.         use the -v option instead.
  239.  
  240. -n  never overwrite existing files
  241.         By default, Qunzip checks to see if the files you are extracting
  242.         would overwrite existing files and prompts you to see if that's
  243.         what you really want to do.  By including the -n option on the
  244.         command line, you can instruct Qunzip to never overwrite existing
  245.         files and never prompt you.
  246.  
  247. -o  overwrite files without prompting
  248.         This is the reverse of the -n option.  By including the -o option
  249.         on the command line, Qunzip will overwrite existing files with the
  250.         ones extracted from the zipfile without prompting you.  Use this
  251.         option with care!
  252.  
  253. -s  suppress zipfile comment display
  254.         By default, Qunzip will display any zipfile comment contained in
  255.         the zipfile being processed.  If you would prefer to maintain a
  256.         clean screen and not see the comment, add this option to the command
  257.         line or environment variable.
  258.  
  259. -t  test zipfile contents
  260.         On occasion you may wish to test the integrity of a zipfile to be
  261.         sure that the contents are good.  Adding the -t option to the
  262.         command line causes Qunzip to completely test the zipfile for
  263.         any damage without extracting any files.
  264.  
  265. -u  update existing files
  266.         This option is similar in function to the -f 'Freshen' option.  It
  267.         causes Qunzip to only replace existing files if they are older than
  268.         the ones contained in the zipfile.  The -u option also extracts files
  269.         that are not already existing, creating new files as necessary.
  270.  
  271. -v  verbose list of zipfile contents
  272.         Using the -v option on the command line causes Qunzip to produce a
  273.         full (verbose) listing of the contents of the zipfile, including
  274.         technical data.  For a shorter listing, use the -l option instead.
  275.  
  276. -x  extract files
  277.         Same as the -e command - see the description of -e for information.
  278.  
  279. -z  display only the zipfile comment
  280.         The -z option allows you to view the comment in a zipfile if one is
  281.         present, without extracting any files.
  282.  
  283. -3  disable use of 32-bit instructions
  284.         Qunzip automatically senses the type of CPU it is running on, and uses
  285.         32-bit processing for greater performance if the machine is capable of
  286.         supporting this mode of operation.  Qunzip's internal CPU type
  287.         detection is *very* reliable, and you should never need to use this
  288.         option.  However, if you're running Qunzip in an environment that can
  289.         not handle applications running in 32-bit mode you may need to set
  290.         this option.
  291.         Or if you're running Qunzip on a CPU type that it does not understand,
  292.         it will default to using 8088 compatible instructions.  If the machine
  293.         is capable of running 32-bit code, then setting -3- (minus sign on
  294.         both sides) will tell Qunzip to use the faster 32-bit instructions.
  295.         WARNING: Using the -3- option on a machine that can not support 32-bit
  296.         instructions will cause a system crash (at the very least)!  If you're
  297.         not sure what to do with the -3 option, don't use it at all.
  298.  
  299.  
  300. Exit Codes:
  301. ─────────────────────────────────────────────────────────────────────────────
  302.         Qunzip returns an exit code upon termination showing the status of
  303.         its operation.  These exit codes can be tested in batch files set
  304.         up for unattended operation to determine if the Qunzip operation was
  305.         successful, and if not to indicate the cause of failure.  A list of
  306.         the possible exit codes and their meaning follows:
  307.  
  308. 0 (Success):
  309.         All operations completed successfully; no errors or warnings.
  310.  
  311. 1 (Warning):
  312.         Files extracted successfully; one or more skipped or damaged.
  313.  
  314. 2 (Error in zipfile):
  315.         Some files extracted successfully; zipfile is corrupt.
  316.  
  317. 3 (Severe error in zipfile):
  318.         Zipfile corrupt; no files extracted.
  319.  
  320. 4 (Insufficient memory):
  321.         Insufficient free memory available for Qunzip to run.
  322.  
  323. 9 (File not found):
  324.         One or more filenames on the command line were not found.
  325.  
  326. 10 (Bad command line parameters):
  327.         Command line options invalid or contradictory.
  328.  
  329. 11 (No files found):
  330.         Zipfile was empty - no files to process.
  331.  
  332. 50 (Disk full):
  333.         Insufficient free space available on disk to extract files.
  334.  
  335. 51 (Unexpected EOF):
  336.         End of file reached prematurely - zipfile is corrupt.
  337.  
  338.  
  339. Qunzip Error Messages:
  340. ─────────────────────────────────────────────────────────────────────────────
  341. CRC error in file:
  342.         Qunzip was able to extract this file from the zipfile, but the
  343.         extracted file was not an exact copy of the original file as
  344.         it was originally stored in the zipfile.  This file is damaged
  345.         in some way and may not be usable, and the zipfile is also
  346.         damaged.
  347.  
  348. Error reading zipfile:
  349.         Qunzip was able to find and start reading the zipfile, but an
  350.         error occured as it continued to read it.  This error is most
  351.         likely to occur on a network or multi-tasking system when file
  352.         sharing is not working properly, or SHARE is not loaded.
  353.  
  354. Zipfile corrupt or not a zipfile:
  355.         The filename given to Qunzip as the zipfile to work with is either
  356.         not a zipfile, or is so badly damaged that it is not recognizable
  357.         as a zipfile and no files can be extracted.
  358.  
  359. Out of memory:
  360.         There is not enough free memory for Qunzip to run.  Make sure that
  361.         there is at least 110K of free memory before running Qunzip.
  362.  
  363. Unknown compression method:
  364.         The file that Qunzip is trying to extract has been compressed in
  365.         a ZIP format that Qunzip does not understand, or the zipfile may
  366.         be damaged.  Qunzip can handle all ZIP compression methods used
  367.         by Qzip, or PKZIP versions 1.00 through 2.04.
  368.  
  369. File is encrypted - skipping:
  370.         The file that Qunzip is trying to extract has been encrypted or
  371.         'scrambled' by PKZIP.  Qunzip does not extract encrypted files;
  372.         this file will just be skipped.
  373.  
  374. Error writing file - Disk full:
  375.         Qunzip was unable to write the extracted file to disk because there
  376.         is not sufficient room for it.  Delete some unnecessary files from
  377.         your disk and try again.
  378.  
  379. Invalid command line arguments:
  380.         The options you included on the Qunzip command line were incorrect
  381.         or invalid.
  382.  
  383. Unable to find or open zipfile:
  384.         Qunzip was not able to find or open the zipfile for reading.  Either
  385.         the filename you specified is incorrect, the file is not located in
  386.         the directory you specified, that file is locked by another process,
  387.         or you don't have sufficient network rights to access that file.
  388.  
  389. Invalid destination directory:
  390.         The directory that you included on the command line for Qunzip to
  391.         place the extracted files in was improperly specified, or it does
  392.         not exist.
  393.  
  394. Zipfile is empty:
  395.         The zipfile that Qunzip is trying to process contains no files.
  396.  
  397. File not found in zipfile:
  398.         The file that you asked Qunzip to extract from the zipfile was not
  399.         found within the zipfile.
  400.  
  401. Drive not ready:
  402.         DOS was unable to access the drive you specified; if this was a
  403.         floppy drive, check to make sure the disk is inserted.  If you
  404.         specified a hard drive, a serious hardware problem is indicated.
  405.  
  406.  
  407. Credits:
  408. ─────────────────────────────────────────────────────────────────────────────
  409.         PKUnzip and PKZip are trademarks of PKWARE Inc.
  410.         DOS and Windows are trademarks of Microsoft Corp.
  411.         IBM and OS/2 are trademarks of International Business Machines, Inc.
  412.